package com.ld.poetry.entity;

import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;
import lombok.EqualsAndHashCode;

import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * 树洞实体类
 * 
 * 功能说明：
 * 1. 用于存储用户匿名留言信息
 * 2. 支持用户头像和留言内容
 * 3. 记录留言创建时间
 * 
 * 使用场景：
 * 1. 用户匿名留言
 * 2. 树洞内容展示
 * 3. 留言管理
 * 
 * 注意事项：
 * 1. 留言内容需要审核
 * 2. 头像使用默认或随机生成
 * 3. 创建时间自动记录
 * 
 * @author sara
 * @since 2021-09-14
 */
@Data
@EqualsAndHashCode(callSuper = false)
@TableName("tree_hole")
public class TreeHole implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 树洞ID
     * 
     * 功能说明：
     * 1. 唯一标识树洞记录
     * 2. 自增主键
     * 
     * 数据库字段：
     * - 字段名：id
     * - 类型：INT
     * - 约束：主键，自增
     * 
     * 使用场景：
     * 1. 树洞记录的唯一标识
     * 2. 树洞记录的关联查询
     */
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    /**
     * 用户头像
     * 
     * 功能说明：
     * 1. 存储用户头像URL
     * 2. 支持默认头像
     * 
     * 数据库字段：
     * - 字段名：avatar
     * - 类型：VARCHAR
     * - 约束：可空
     * 
     * 使用场景：
     * 1. 树洞留言展示
     * 2. 用户身份标识
     */
    @TableField("avatar")
    private String avatar;

    /**
     * 留言内容
     * 
     * 功能说明：
     * 1. 存储用户留言文本
     * 2. 支持富文本内容
     * 
     * 数据库字段：
     * - 字段名：message
     * - 类型：TEXT
     * - 约束：非空
     * 
     * 使用场景：
     * 1. 树洞内容展示
     * 2. 留言内容管理
     * 
     * 注意事项：
     * 1. 内容需要审核
     * 2. 敏感词过滤
     * 3. 长度限制
     */
    @TableField("message")
    private String message;

    /**
     * 创建时间
     * 
     * 功能说明：
     * 1. 记录留言创建时间
     * 2. 自动填充
     * 
     * 数据库字段：
     * - 字段名：create_time
     * - 类型：DATETIME
     * - 约束：非空
     * 
     * 使用场景：
     * 1. 留言时间排序
     * 2. 时间轴展示
     * 3. 数据统计
     */
    @TableField("create_time")
    private LocalDateTime createTime;
}
